/**
 * Copyright 2009-2010 rpn4j.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.rpn4j;

import org.rpn4j.ctx.Context;

/**
 * Interface description defining what can be done with {@code Rpn}.
 * 
 * @author hillger.t
 */
public interface Rpn {
  
  /**
   * Sets the context to use with this {@code Rpn}.
   * 
   * @param context The context.
   */
  public void setContext(Context context);
  
  /**
   * Returns the context used within this {@code Rpn}.
   * 
   * @return
   */
  public Context getContext();
  
  /**
   * Clears all input for a new calculation.
   */
  public void reset();

  /**
   * Calculates all input parameters provided and returns the result as a double
   * value.
   * 
   * @return The result.
   */
  public double calculate();
}
